home *** CD-ROM | disk | FTP | other *** search
/ Info-Mac 4 / Info_Mac IV CD-ROM (Pacific HiTech Inc.)(August 1994).iso / Sumex-Aim Help / File Names and Places < prev    next >
Text File  |  1993-12-31  |  5KB  |  112 lines
  1. Info-Mac Archive File Name and Placement Conventions
  2. revision 17 Jul 93: DRAFT VERSION
  3.  
  4. --- File Names ----------------------------------------------------------
  5.  
  6. File Names Must:
  7.   Contain ONLY lowercase letters, numbers, and dashes.
  8.   Begin with a letter, not a number or dash.
  9.   Be 50 characters or less with its directory name(s).
  10.   Use dashes where words are separated (but not too much).
  11.   Exclude periods from version numbers.
  12.   Exclude references to compression software.
  13.   End with one of the following suffixes:
  14.     .hqx  Binhexed
  15.     .txt  text 
  16.    .shar  Unix shell archives
  17.      .uu  Unix uuencoded
  18.     .bin  MacBinary format (rarely used)
  19.     .etx  Setext (only for Tidbits issues)
  20.   Some examples:
  21.     DrawNothing 1.41 -> draw-nothing-141.hqx
  22.     doIt Now 0.9b    -> doit-now-09b.hqx
  23.     QuickTime 2.0    -> quicktime-20.hqx
  24.  
  25. Specific File Format
  26.   To identify the format of the file more specifically than the suffix
  27.   does, use an extension JUST BEFORE the suffix. Some common ones:
  28.   -msdos  MS-DOS program
  29.    -unix  Unix program
  30.      -ps  Postscript code
  31.     -etx  Setext text format
  32.     -msw  Microsoft Word
  33.    -fkey  Mac fkey utility
  34.      -hc  Hypercard stacks
  35.  
  36. Descriptive Extensions
  37.   Some info about files should be placed in file name extensions:
  38.    -demo  incomplete version for demonstration purposes
  39.    -updt  a utility to update a file to a newer version
  40.  
  41. References to Common Mac Things
  42.   System software: sys607, sys7, sys701, sys71, sys7-finder
  43.               Not: system-7, system-seven, system7, finder7, finder-7
  44.   Mac models: mac-512, mac-plus, mac-se, mac-ii, se30, iici, lcii
  45.               mac-portable, powerbook, centris-610, quadra-700
  46.          Not: power-book, pb, ii-vx,
  47.   Other software: resedit, quicktime, mactcp
  48.   System operations: startup, shutdown
  49.  
  50. Date Format
  51.   The format for dates is
  52.     "file-name-YY-MM.???"
  53.   where YY and MM are the numbers of the year and month,
  54.   respectively.  If necessary "-DD" (the day) may be added
  55.   after the month.
  56.  
  57. Conventions for Specific Directories
  58.   app/ Filemaker stuff should begin with "filemaker-"
  59.   per/ File names should include an issue number or date (not both)
  60.   dev/a4d/ File names should end in one of the following extensions:
  61.      -ext  externals
  62.     -demo  commercial demos
  63.       -db  example databases
  64.     -info  documentation and information
  65.     -util  utilities that don't plug directly into 4D or a database
  66.      -src  native 4d source code
  67.   dev/src/ File names should end in one of the following extensions:
  68.        -c  C source code
  69.      -pas  Pascal source code
  70.     -plog  Prolog source code
  71.   info/ Software and hardware company info should begin with "vendor-"
  72.   info/hdwr/ Specific mac model info should begin with the model name
  73.  
  74. --- File Placement ---------------------------------------------------
  75.  
  76. Things should be archived by topic as much as possible.  Some
  77. directories are more specific than others, text/ and prn/ are quite
  78. definite, whereas app/ and cfg/ are more general.  Things should be
  79. placed in the most specific directory appropriate, ie: printer drivers
  80. in prn/, not cfg/.
  81.  
  82. Generally, information files about software should be archived
  83. together with applications, whereas data (such as sounds and pictures)
  84. should be archived separately.  For example, a picture goes in grf/,
  85. the utility to display it goes in grf/util/ and a review or collection
  86. of tips about that utility also goes in grf/util/.
  87.  
  88. Hypercard stacks, desk accessories and other apps that provide info
  89. ABOUT MACS should be placed in the appropriate info/ or topic
  90. directory, not in card/ or app/.
  91.  
  92. --- Archive Directories ------------------------------------------------
  93.  
  94. A directory at the archive has many components:
  95. + An entry in directory-contents.txt with a description of the
  96.   directory's intended contents.
  97. + The directory itself, which is a short 3 or 4 character name.
  98. + A link to the directory that resides in the same directory as the
  99.   real directory.  Its name is descriptive and capitalized.  If its
  100.   name is two words normally separated by a space, the 2nd word is also
  101.   capitalized.  If its name is 2 words that represent different
  102.   concepts, the 2nd word is capitalized and separated from the 1st by a
  103.   dash.
  104. + An abstract file in the directory (an empty one must be created when
  105.   a directory is installed).
  106. + A link to the abstract file that resides in help/abs/.  Its name
  107.   begins with the descriptive name of the parent directory (if any)
  108.   followed by the descriptive name of the directory.  Dashes are used in
  109.   this name to separate words as they are in normal archive files.
  110. + A directory in the backmod/ar/ hierarchy whose name is the same as
  111.   the directory's actual name.
  112.